Repository navigation
chore(cloud-assembly-api): remove files that are now no longer used - #2060
Conversation
7a6fd57 to
24885d3
Compare
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned Files
|
|
Automated review A maintainer will still review this — treat the notes below as a starting point. 📌 Commit This chore PR removes two now-superseded modules from 🔴 0 blocking · 🟡 2 recommended · ⚪ 0 optional Files with findings (2)
Generated automatically. React 👍 or 👎 to tell us whether this review helped, so we can improve these reviews. |
![maintainer-for-aws[bot]](https://avatars.githubusercontent.com/b/1290?s=60&v=4){kind=small}
There was a problem hiding this comment.
See the review summary comment for the overview; the notes below are inline.
| export * from './bootstrap'; | ||
| export * from './construct-tree'; | ||
| export * from './template-ranges'; | ||
| export * from './stack-trace'; |
There was a problem hiding this comment.
🟡 Recommended — These two lines remove export * from './construct-tree' and export * from './template-ranges' from the barrel of @aws-cdk/cloud-assembly-api, a publicly published package (publishConfig.access: public). That drops exported symbols — buildConstructTree, buildConstructTreeAsync, ConstructIndex, ConstructTreeNode, resolveResourceRange, resolveResourceRanges, resolveLogicalIdAtOffset, indexTemplateRanges, OffsetRange, ResourceRanges, TemplateRanges — from a released surface. Since backwards compatibility is a stated principle for this repo (AGENTS.md#your-role), please confirm the removal is intentional and that no external programmatic consumer depends on these.
Suggested change: Confirm in the PR description that these recently-added exports were never intended as stable public API and that no external consumer relies on them. If any external-consumer risk exists, add a deprecation note or stage the removal rather than dropping the exports outright.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## explorer_4_web_explorer #2060 +/- ##
========================================================
Coverage 92.08% 92.08%
========================================================
Files 83 83
Lines 13246 13246
Branches 1885 1886 +1
========================================================
Hits 12197 12197
Misses 1011 1011
Partials 38 38
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
24885d3 to
8a0a915
Compare
There was a problem hiding this comment.
See the review summary comment for the overview; the notes below are inline.
| @@ -272,7 +271,6 @@ __metadata: | |||
| eslint-plugin-prettier: "npm:^4.2.5" | |||
| jest: "npm:^29.7.0" | |||
There was a problem hiding this comment.
🟡 Recommended — This removes the @types/json-source-map and json-source-map references from the @aws-cdk/cloud-assembly-api workspace entry, but the top-level package definition block for @types/json-source-map@npm:^0.6.0 (yarn.lock lines 4423-4428 on the PR head) is left in place with nothing referencing it anymore. A clean yarn install on this branch would prune that orphaned definition, so the committed lockfile does not match what the package manager would regenerate, which the repo's lockfile/self-mutation validation (AGENTS.md#projen--project-configuration) is designed to catch. The sibling json-source-map@npm:^0.6.1 definition is correctly retained because the published package still declares it.
Suggested change: Run yarn install at the repo root on this branch and commit the resulting yarn.lock, which should drop the orphaned @types/json-source-map@npm:^0.6.0 definition block.
|
Total lines changed 9831 is greater than 1000. Please consider breaking this PR down. |
…mplate-ranges `AssemblyIndex` now provides the construct tree and template ranges, so the standalone `construct-tree.ts` and `template-ranges.ts` modules have no remaining consumers in this repo: `cdk-explorer` reads ranges through its own `lib/core/template-ranges.ts` and `toolkit-lib` has its own `ConstructTreeNode` in `lib/api/tree.ts`. BREAKING CHANGE: the `construct-tree` and `template-ranges` exports are removed from `@aws-cdk/cloud-assembly-api`. Nothing in this repository used them; external consumers should move to `AssemblyIndex`. This also drops the `json-source-map` runtime dependency from `cloud-assembly-api` (`cdk-explorer` keeps its own copy).
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
The earlier PRs in this stack refactored the assembly loading API in
cloud-assembly-api, and these files are no longer needed. Also gets rid of a now-unused dependency.BREAKING CHANGE: this removes some exports that used to be there.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license